Rename max_splits to max_history_splits, set default value to 1.0e7 #2954
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
It was noted that the two variables max_split and max_splits had very similar naming. Max_split is a member of the weight window object and limits the number of splits during a single check against the weight window. Max_splits is a member of the settings object and limits the number of times a history can be split. Max_splits has a notable effect on the effectiveness of the weight window while max_split does not.
It was also found that the default value of 1000 splits is not enough when you have many orders of magnitude decrease in your flux across your model.
This PR renames the variable max_splits variable to max_history_splits to make it more clear for users and sets the default value of max_history_splits to be 1.0e7.
Fixes #2774
Checklist